docs: add safety warning to Array.from_buffers docstring#49799
Closed
avasis-ai wants to merge 1 commit intoapache:mainfrom
Closed
docs: add safety warning to Array.from_buffers docstring#49799avasis-ai wants to merge 1 commit intoapache:mainfrom
avasis-ai wants to merge 1 commit intoapache:mainfrom
Conversation
|
Thanks for opening a pull request! If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project. Then could you also rename the pull request title in the following format? or See also: |
Member
|
Avasis.ai creates agents designed to open PRs in OS repositories. In order to save maintainers time I will close this. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
.. warning::directive to theArray.from_buffersdocstring to explicitly inform callers that they are responsible for passing valid Arrow data matching the given type, and that passing invalid data may lead to crashes or undefined behavior.This addresses the concern raised in the issue that users may not be aware of the safety implications of using this low-level API.
Closes #49717